<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.masks</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;masks
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.masks-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="py2ecotect.doc.masks-module.html">Module py2ecotect.doc.masks</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Package py2ecotect=py2ecotect-module.html"><a title="py2ecotect" class="py-name" href="#" onclick="return doclink('link-0', 'py2ecotect', 'link-0');">py2ecotect</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">p2e</tt> </tt>
<a name="Masks"></a><div id="Masks-def"><a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt> <a class="py-toggle" href="#" id="Masks-toggle" onclick="return toggle('Masks');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html">Masks</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Masks-expanded"><a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line">     </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line">    <tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment"># Commands</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment"></tt>     </tt>
<a name="Masks.clear"></a><div id="Masks.clear-def"><a name="L9"></a><tt class="py-lineno">  9</tt> <a class="py-toggle" href="#" id="Masks.clear-toggle" onclick="return toggle('Masks.clear');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#clear">clear</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.clear-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.clear-expanded"><a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">        Deletes the shading masks list and frees allocated memory. If a future </tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">        calculation requires shading masks, ECOTECT will attempt to re-load them </tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">        from the cache file on disk. </tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">        There are no parameters for this command.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Variable py2ecotect._app=py2ecotect-module.html#_app"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-1', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"masks.clear"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"> </tt>
<a name="Masks.copy"></a><div id="Masks.copy-def"><a name="L22"></a><tt class="py-lineno"> 22</tt> <a class="py-toggle" href="#" id="Masks.copy-toggle" onclick="return toggle('Masks.copy');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#copy">copy</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">_from</tt><tt class="py-op">,</tt> <tt class="py-param">to</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.copy-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.copy-expanded"><a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">        Copies all day information from one shading mask to another. </tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">        This command takes the following parameters.</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">        _from </tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask to copy from. </tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">        to </tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask to copy to.</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module py2ecotect._util=py2ecotect._util-module.html"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-2', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Function py2ecotect._util._convert_args_to_string()=py2ecotect._util-module.html#_convert_args_to_string"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-3', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"masks.copy"</tt><tt class="py-op">,</tt> <tt class="py-name">_from</tt><tt class="py-op">,</tt> <tt class="py-name">to</tt> <tt class="py-op">)</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-4', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"> </tt>
<a name="Masks.interpolate"></a><div id="Masks.interpolate-def"><a name="L40"></a><tt class="py-lineno"> 40</tt> <a class="py-toggle" href="#" id="Masks.interpolate-toggle" onclick="return toggle('Masks.interpolate');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#interpolate">interpolate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">t1</tt><tt class="py-op">,</tt> <tt class="py-param">t2</tt><tt class="py-op">,</tt> <tt class="py-param">fraction</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.interpolate-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.interpolate-expanded"><a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">        Interpolates between the values in two masks and stores them in a new mask. </tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">        This command takes the following parameters.</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask where the interpolation will be </tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">        stored. </tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">        t1 </tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask from which the interpolation </tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">        will begin. </tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">        t2 </tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask at which the interpolation </tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">        will end. </tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">        fraction </tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">        The fractional mask bias for the interpolation, typically between 0 (t1) </tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">        and 1 (t2).</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-5', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-6', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"masks.interpolate"</tt><tt class="py-op">,</tt>  </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">                                                      <tt id="link-7" class="py-name" targets="Method py2ecotect.doc.select.Select.index()=py2ecotect.doc.select.Select-class.html#index"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-7', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">t1</tt><tt class="py-op">,</tt> <tt class="py-name">t2</tt><tt class="py-op">,</tt> <tt class="py-name">fraction</tt> <tt class="py-op">)</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-8', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"> </tt>
<a name="Masks.load"></a><div id="Masks.load-def"><a name="L69"></a><tt class="py-lineno"> 69</tt> <a class="py-toggle" href="#" id="Masks.load-toggle" onclick="return toggle('Masks.load');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#load">load</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.load-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.load-expanded"><a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">        Loads the shading mask list. </tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">        There are no parameters for this command.</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-9', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"masks.load"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"> </tt>
<a name="Masks.save"></a><div id="Masks.save-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <a class="py-toggle" href="#" id="Masks.save-toggle" onclick="return toggle('Masks.save');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#save">save</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.save-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.save-expanded"><a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">        Saves the current shading mask list. </tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring">        There are no parameters for this command.</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-10', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"masks.save"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"> </tt>
<a name="Masks.update"></a><div id="Masks.update-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="Masks.update-toggle" onclick="return toggle('Masks.update');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#update">update</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.update-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.update-expanded"><a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring">        Updates the specified shading mask's information. </tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">        This command takes the following parameters.</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-11', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-12', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"masks.update"</tt><tt class="py-op">,</tt> <tt id="link-13" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-13', 'index', 'link-7');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-14', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"> </tt>
<a name="Masks.add_mask"></a><div id="Masks.add_mask-def"><a name="L106"></a><tt class="py-lineno">106</tt> <a class="py-toggle" href="#" id="Masks.add_mask-toggle" onclick="return toggle('Masks.add_mask');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#add_mask">add_mask</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">object</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.add_mask-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.add_mask-expanded"><a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">        Adds a new shading mask to the masks list and returns the zero-based </tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">        index of the mask just added. </tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">        [object] </tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">        This optional parameter sets the index to which the new shading mask </tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">        will be assigned to. </tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">        maskIndex </tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the new shading mask.</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-15', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-16', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"add.mask"</tt><tt class="py-op">,</tt> <tt id="link-17" class="py-name" targets="Method py2ecotect.doc.select.Select.object()=py2ecotect.doc.select.Select-class.html#object"><a title="py2ecotect.doc.select.Select.object" class="py-name" href="#" onclick="return doclink('link-17', 'object', 'link-17');">object</a></tt><tt class="py-op">)</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-18', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-19', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Function py2ecotect._util._convert_str_to_type()=py2ecotect._util-module.html#_convert_str_to_type"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-20', '_convert_str_to_type', 'link-20');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line">     </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line">    <tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment"># Properties</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-comment"></tt>     </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">    <tt class="py-decorator">@</tt><tt class="py-decorator">apply</tt> </tt>
<a name="Masks.count"></a><div id="Masks.count-def"><a name="L135"></a><tt class="py-lineno">135</tt> <a class="py-toggle" href="#" id="Masks.count-toggle" onclick="return toggle('Masks.count');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#count">count</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.count-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.count-expanded"><a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">        <tt class="py-keyword">def</tt> <tt class="py-def-name">fget</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line">            <tt class="py-docstring">"""</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">            Returns the number of shading masks in the current list. If no masks </tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring">            have been loaded, a value of 0 will be returned. </tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">            Parameter(s)</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">            There are no parameters for this property.</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">            Return Value(s)</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring">            Getting this property returns the following value(s).</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt class="py-docstring">            count </tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-docstring">            The number of shading masks in the list.</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-docstring">            </tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt class="py-docstring">            """</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">            <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-21', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.count"</tt><tt class="py-op">)</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-22', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-23', '_convert_str_to_type', 'link-20');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">         </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">locals</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_data"></a><div id="Masks.get_data-def"><a name="L157"></a><tt class="py-lineno">157</tt> <a class="py-toggle" href="#" id="Masks.get_data-toggle" onclick="return toggle('Masks.get_data');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_data">get_data</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">i</tt><tt class="py-op">,</tt> <tt class="py-param">j</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_data-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_data-expanded"><a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"><tt class="py-docstring">        Retrieves the shading value for the specified azimuth and altitude </tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line"><tt class="py-docstring">        indexes in the sky. </tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line"><tt class="py-docstring">        i </tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line"><tt class="py-docstring">        A value between 0 and 71 representing the azimuth angle corresponding </tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line"><tt class="py-docstring">        to a sky segment. </tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"><tt class="py-docstring">        j </tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-docstring">        A value between 0 and 17 representing the altitude angle corresponding </tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-docstring">        to a sky segment. </tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring">        shading </tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value between 0 (unshaded) and 1 (fully shaded) representing </tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring">        the effective shading of the object whose shadng mask is specified. </tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-24', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-25', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.data"</tt><tt class="py-op">,</tt> <tt id="link-26" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-26', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt>  </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">                                                     <tt class="py-name">j</tt><tt class="py-op">)</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-27', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-28', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-29', '_convert_str_to_type', 'link-20');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line"> </tt>
<a name="Masks.set_data"></a><div id="Masks.set_data-def"><a name="L190"></a><tt class="py-lineno">190</tt> <a class="py-toggle" href="#" id="Masks.set_data-toggle" onclick="return toggle('Masks.set_data');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#set_data">set_data</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">i</tt><tt class="py-op">,</tt> <tt class="py-param">j</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.set_data-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.set_data-expanded"><a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring">        Sets the shading value for the specified at the given azimuth and </tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring">        altitude indexes over the sky. </tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring">        i </tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">        A value between 0 and 71 representing the azimuth angle as an index </tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring">        corresponding to a sky segment. </tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"><tt class="py-docstring">        j </tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line"><tt class="py-docstring">        A value between 0 and 17 representing the altitude angle as an index </tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line"><tt class="py-docstring">        corresponding to a sky segment. </tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring">        value </tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value between 0 (unshaded) and 1 (fully shaded) representing </tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">        the effective shading of the object whose shading mask is specified.</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-30', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-31', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.masks.data"</tt><tt class="py-op">,</tt> <tt id="link-32" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-32', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt>  </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">                                                     <tt class="py-name">j</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-33', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_object"></a><div id="Masks.get_object-def"><a name="L219"></a><tt class="py-lineno">219</tt> <a class="py-toggle" href="#" id="Masks.get_object-toggle" onclick="return toggle('Masks.get_object');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_object">get_object</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_object-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_object-expanded"><a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line"><tt class="py-docstring">        Retrieves the zero-based index of the object to which the specified mask </tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line"><tt class="py-docstring">        belongs. </tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line"><tt class="py-docstring">        object </tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the object.</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-34', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-35', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.object"</tt><tt class="py-op">,</tt> <tt id="link-36" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-36', 'index', 'link-7');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-37', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-38', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-39', '_convert_str_to_type', 'link-20');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"> </tt>
<a name="Masks.set_object"></a><div id="Masks.set_object-def"><a name="L242"></a><tt class="py-lineno">242</tt> <a class="py-toggle" href="#" id="Masks.set_object-toggle" onclick="return toggle('Masks.set_object');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#set_object">set_object</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.set_object-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.set_object-expanded"><a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line"><tt class="py-docstring">        Sets the object to which the specified mask will belong. You can use </tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line"><tt class="py-docstring">        this property to change shading masks at any time during a calculation. </tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt class="py-docstring">        object </tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the object. </tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-40', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-41', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.masks.object"</tt><tt class="py-op">,</tt> <tt id="link-42" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-42', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line">                                                      <tt id="link-43" class="py-name"><a title="py2ecotect.doc.select.Select.object" class="py-name" href="#" onclick="return doclink('link-43', 'object', 'link-17');">object</a></tt><tt class="py-op">)</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-44', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_percentage"></a><div id="Masks.get_percentage-def"><a name="L262"></a><tt class="py-lineno">262</tt> <a class="py-toggle" href="#" id="Masks.get_percentage-toggle" onclick="return toggle('Masks.get_percentage');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_percentage">get_percentage</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_percentage-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_percentage-expanded"><a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">        Returns the percentage-in-shade of the object/mask at the current model </tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt class="py-docstring">        date and time as a single decimal percentage value. </tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line"><tt class="py-docstring">        shading </tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value between 0 (unshaded) and 100 (fully shaded) representing </tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line"><tt class="py-docstring">        the effective percentage shading of the object whose shading mask is </tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"><tt class="py-docstring">        specified. </tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring">        cosAngle </tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal fraction representing the effect of direct incidence. This is </tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line"><tt class="py-docstring">        equal to the cosine of the 3D incidence angle between the centre-point </tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line"><tt class="py-docstring">        of the sky segment and the surface normal of the object represented by </tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line"><tt class="py-docstring">        the mask.</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-45', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-46', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.percentage"</tt><tt class="py-op">,</tt> <tt id="link-47" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-47', 'index', 'link-7');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-48', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-49', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-50" class="py-name" targets="Function py2ecotect._util._convert_str_to_list()=py2ecotect._util-module.html#_convert_str_to_list"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-50', '_convert_str_to_list', 'link-50');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_percentage_angle"></a><div id="Masks.get_percentage_angle-def"><a name="L293"></a><tt class="py-lineno">293</tt> <a class="py-toggle" href="#" id="Masks.get_percentage_angle-toggle" onclick="return toggle('Masks.get_percentage_angle');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_percentage_angle">get_percentage_angle</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">azi</tt><tt class="py-op">,</tt> <tt class="py-param">alt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_percentage_angle-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_percentage_angle-expanded"><a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-docstring">        Returns the percentage-in-shade of the specified mask as a single </tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line"><tt class="py-docstring">        decimal percentage value from a source located at the given angles. </tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring">        azi </tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">        The azimuth (-180 deg to 180 deg) angle representing, together with the </tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"><tt class="py-docstring">        altitude angle, a point in the sky from which to retrieve the value. To </tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line"><tt class="py-docstring">        retrieve the sun position at any time, use the model.sunangles property. </tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line"><tt class="py-docstring">        alt </tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line"><tt class="py-docstring">        The altitude (0 deg to 90 deg) angle representing, together with the azimuth </tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line"><tt class="py-docstring">        angle, a point in the sky from which to retrieve the value. To retrieve </tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line"><tt class="py-docstring">        the sun position at any time, use the model.sunangles property. </tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line"><tt class="py-docstring">        shading </tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value between 0 (unshaded) and 100 (fully shaded) representing </tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line"><tt class="py-docstring">        the effective percentage shading of the object whose shading mask is </tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"><tt class="py-docstring">        specified. </tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line"><tt class="py-docstring">        cosAngle </tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal fraction representing the effect of direct incidence. This is </tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">        equal to the cosine of the 3D incidence angle between the centre-point </tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring">        of the sky segment and the surface normal of the object represented by </tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line"><tt class="py-docstring">        the mask.</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-51', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-52', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.percentage.angle"</tt><tt class="py-op">,</tt>  </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line">                                                     <tt id="link-53" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-53', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">azi</tt><tt class="py-op">,</tt> <tt class="py-name">alt</tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-54', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-55', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-56', '_convert_str_to_list', 'link-50');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_percentage_datetime"></a><div id="Masks.get_percentage_datetime-def"><a name="L335"></a><tt class="py-lineno">335</tt> <a class="py-toggle" href="#" id="Masks.get_percentage_datetime-toggle" onclick="return toggle('Masks.get_percentage_datetime');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_percentage_datetime">get_percentage_datetime</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">day</tt><tt class="py-op">,</tt> <tt class="py-param">time</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_percentage_datetime-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_percentage_datetime-expanded"><a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line"><tt class="py-docstring">        Returns the percentage-in-shade of the selected object's mask as a </tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line"><tt class="py-docstring">        single decimal percentage value at the given date and time. </tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"><tt class="py-docstring">        day </tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line"><tt class="py-docstring">        The Julian date of the year (1-365) for the percentage value to return. </tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-docstring">        time </tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"><tt class="py-docstring">        The time of the day to use in decimal hours (0.0-23.99). </tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line"><tt class="py-docstring">        shading </tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value between 0 (unshaded) and 100 (fully shaded) representing </tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line"><tt class="py-docstring">        the effective percentage shading of the object whose shading mask is </tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line"><tt class="py-docstring">        specified. </tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line"><tt class="py-docstring">        cosAngle </tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal fraction representing the effect of direct incidence. This is </tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line"><tt class="py-docstring">        equal to the cosine of the 3D incidence angle between the centre-point </tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line"><tt class="py-docstring">        of the sky segment and the surface normal of the object represented by </tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line"><tt class="py-docstring">        the mask.</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-57', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-58', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.percentage.datetime"</tt><tt class="py-op">,</tt>  </tt>
<a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line">                                                     <tt id="link-59" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-59', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">day</tt><tt class="py-op">,</tt> <tt class="py-name">time</tt><tt class="py-op">)</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-60', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-61', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-62', '_convert_str_to_list', 'link-50');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_percentage_index"></a><div id="Masks.get_percentage_index-def"><a name="L373"></a><tt class="py-lineno">373</tt> <a class="py-toggle" href="#" id="Masks.get_percentage_index-toggle" onclick="return toggle('Masks.get_percentage_index');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_percentage_index">get_percentage_index</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">x</tt><tt class="py-op">,</tt> <tt class="py-param">y</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_percentage_index-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_percentage_index-expanded"><a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"><tt class="py-docstring">        Returns the percentage-in-shade of the specified object's mask as a </tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"><tt class="py-docstring">        single decimal percentage value. </tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line"><tt class="py-docstring">        x </tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line"><tt class="py-docstring">        The X index of the shading table, where X is the azimuth angle increment </tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line"><tt class="py-docstring">        set in the set.shading.angles property. </tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line"><tt class="py-docstring">        y </tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line"><tt class="py-docstring">        The Y index of the shading table, where Y is the altitude angle increment </tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line"><tt class="py-docstring">        set in the set.shading.angles property. </tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line"><tt class="py-docstring">        shading </tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value between 0 (unshaded) and 100 (fully shaded) representing </tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt>  <tt class="py-line"><tt class="py-docstring">        the effective percentage shading of the object whose shading mask is </tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line"><tt class="py-docstring">        specified. </tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt>  <tt class="py-line"><tt class="py-docstring">        cosAngle </tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal fraction representing the effect of direct incidence. This is </tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line"><tt class="py-docstring">        equal to the cosine of the 3D incidence angle between the centre-point </tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt>  <tt class="py-line"><tt class="py-docstring">        of the sky segment and the surface normal of the object represented by </tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt>  <tt class="py-line"><tt class="py-docstring">        the mask.</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-63', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-64', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.percentage.index"</tt><tt class="py-op">,</tt>  </tt>
<a name="L409"></a><tt class="py-lineno">409</tt>  <tt class="py-line">                                                     <tt id="link-65" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-65', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">)</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-66', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-67', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-68', '_convert_str_to_list', 'link-50');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line"> </tt>
<a name="Masks.get_shading"></a><div id="Masks.get_shading-def"><a name="L413"></a><tt class="py-lineno">413</tt> <a class="py-toggle" href="#" id="Masks.get_shading-toggle" onclick="return toggle('Masks.get_shading');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#get_shading">get_shading</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">azi</tt><tt class="py-op">,</tt> <tt class="py-param">alt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.get_shading-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.get_shading-expanded"><a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line"><tt class="py-docstring">        Returns the shading value, a decimal value between 0 (unshaded) and 1 </tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line"><tt class="py-docstring">        (fully shaded), representing the effective percentage of the exposed </tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</tt>  <tt class="py-line"><tt class="py-docstring">        surface area of the object that is in shade for the specified sky angles. </tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line"><tt class="py-docstring">        azi </tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line"><tt class="py-docstring">        The azimuth angle, in degrees, representing the compass direction, with </tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line"><tt class="py-docstring">        North being 0 deg. </tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line"><tt class="py-docstring">        alt </tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line"><tt class="py-docstring">        The altitude angle with 0 deg representing horizontal direction and 90 deg</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line"><tt class="py-docstring">        being vertical. </tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line"><tt class="py-docstring">        Return Value(s)</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line"><tt class="py-docstring">        Getting this property returns the following value(s).</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line"><tt class="py-docstring">        value </tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value, between 0 (unshaded) and 1 (fully shaded).</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-69', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-70', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.masks.shading"</tt><tt class="py-op">,</tt> <tt id="link-71" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-71', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L442"></a><tt class="py-lineno">442</tt>  <tt class="py-line">                                                     <tt class="py-name">azi</tt><tt class="py-op">,</tt> <tt class="py-name">alt</tt><tt class="py-op">)</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-72', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-73', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-74', '_convert_str_to_type', 'link-20');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt> </tt>
</div><a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line"> </tt>
<a name="Masks.set_shading"></a><div id="Masks.set_shading-def"><a name="L446"></a><tt class="py-lineno">446</tt> <a class="py-toggle" href="#" id="Masks.set_shading-toggle" onclick="return toggle('Masks.set_shading');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.masks.Masks-class.html#set_shading">set_shading</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">azi</tt><tt class="py-op">,</tt> <tt class="py-param">alt</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Masks.set_shading-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Masks.set_shading-expanded"><a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line"><tt class="py-docstring">        Sets the shading value, representing the effective percentage of the </tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line"><tt class="py-docstring">        object/mask that is in shade using the specified sky angles. </tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line"><tt class="py-docstring">        Parameter(s)</tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line"><tt class="py-docstring">        This property takes the following parameters.</tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line"><tt class="py-docstring">        index </tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt>  <tt class="py-line"><tt class="py-docstring">        The zero-based index of the shading mask. </tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line"><tt class="py-docstring">        azi </tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt>  <tt class="py-line"><tt class="py-docstring">        The azimuth angle, in degrees, representing the compass direction with </tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt>  <tt class="py-line"><tt class="py-docstring">        North being 0 deg. </tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line"><tt class="py-docstring">        alt </tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt>  <tt class="py-line"><tt class="py-docstring">        The altitude angle with 0 deg representing horizontal direction and 90 deg </tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt>  <tt class="py-line"><tt class="py-docstring">        being vertical. </tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line"><tt class="py-docstring">        value </tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line"><tt class="py-docstring">        A decimal value, between 0 (unshaded) and 1 (fully shaded). </tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-75', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-76', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.masks.shading"</tt><tt class="py-op">,</tt> <tt id="link-77" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-77', 'index', 'link-7');">index</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L471"></a><tt class="py-lineno">471</tt>  <tt class="py-line">                                                     <tt class="py-name">azi</tt><tt class="py-op">,</tt> <tt class="py-name">alt</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-78', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L473"></a><tt class="py-lineno">473</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:49 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
